home *** CD-ROM | disk | FTP | other *** search
/ CD Ware Multimedia 1994 November / Cd Ware (Nro. 2) - Epimundo.iso / DOS / CM / CLNP_100.ZIP / CLNP.DOC < prev    next >
Encoding:
Text File  |  1994-05-20  |  11.2 KB  |  202 lines
  1. ┌─────────────────────────────────────────────────────────────────────────────┐
  2. │ [CLNP]                    Custom Login Note Pad PPE                  [CLNP] │
  3. └─────────────────────────────────────────────────────────────────────────────┘
  4.               Custom Login Note Pad PPE (c) 1994 by Midnight Slasher
  5.                     <Internet E-Mail Address: mslasher@io.org>
  6.                         Version: 1.00 Standard / Freeware
  7.                                    - 05/20/94 -
  8. ───────────────────────────────────────────────────────────────────────────────
  9. ───────────────────────────────────────────────────────────────────────────────
  10.  
  11. ───────────────────────────────────────────────────────────────────────────────
  12. [ FILES INCLUDED ] ····························································
  13. ───────────────────────────────────────────────────────────────────────────────
  14.   CLNP.DAT ····· The Data Configuration File
  15.   CLNP.DOC ····· Documentation and Installation Guide
  16.   CLNP.DS1 ····· The Display File shown when entering the recipients name. (o)
  17.   CLNP.DS2 ····· The Display File shown on top of the note editor.         (o)
  18.   CLNP.EX1 ····· The Exclusion List File (Can't Receive Notes) (Optional)
  19.   CLNP.EX2 ····· The Exclusion List File (Can't Send Notes)    (Optional)
  20.   CLNP.PPE ····· The Node Activity Viewer PPE
  21.   FILE_ID.DIZ ·· Description Identification File
  22. ───────────────────────────────────────────────────────────────────────────────
  23.  
  24. ───────────────────────────────────────────────────────────────────────────────
  25. [ PROGRAM SUMMARY ] ···························································
  26. ───────────────────────────────────────────────────────────────────────────────
  27.        This PPE  (*PCBoard Programming Language Executable*) installs in two
  28.   places and requires PCBoard v15.1+.   Its purpose is to add the ability to
  29.   send a two line login note to other users on the system. For example, user
  30.   A would be able to send a  two line note to user B.  When user B next logs
  31.   onto the BBS, the note  will be displayed  to them and then  automatically
  32.   deleted.   This PPE has the ability to reject certain users from accessing
  33.   the program  (if it is ever abused)  by an exclusion file, and also has an
  34.   exclusion file so notes can not be sent to  certain users.  Any  automated
  35.   scripts that the user might be using will not be affected by the PPE since
  36.   it times out after a specified number of seconds and continues on with the
  37.   login process.  The display is very configurable.  Multiple  notes sent to
  38.   the same user are displayed in an updated note  box when the  user logs on
  39.   (if they support ANSI). Receipt notes are sent once the note has been read
  40.   by the recipient, and much more. If you want to try this  PPE, follow  the
  41.   installation instructions, or, continue reading to find out more about it!
  42. ───────────────────────────────────────────────────────────────────────────────
  43.  
  44.  
  45. ───────────────────────────────────────────────────────────────────────────────
  46. [ INSTALLATION ] ······························································
  47. ───────────────────────────────────────────────────────────────────────────────
  48.   1. Load PCBSETUP
  49.   2. Press B        ( File Locations )
  50.   3. Press B        ( Configuration Files )
  51.   4. Edit CMD.LST   ( Press F2 at the CMD.LST File )
  52.  
  53.            Command      Security       PPE
  54.            -------      --------       ------------------
  55.         ┌- NOTE         ##             DRIVE:\PATH\CLNP.PPE /EDIT
  56.       ┌─┼- L-NOTE       ##             C:\PCB\PPE\CLNP.PPE /EDIT
  57.       │ └- CLNP         ##             C:\PCB\PPE\CLNP.PPE /EDIT
  58.       │
  59.       └ Use whatever command you like ..
  60.  
  61.      Make sure to include the /EDIT parameter so the program loads into
  62.      EDIT mode. (to write notes to other users)
  63.  
  64.   5. Copy the CLNP.* file(s) to the SAME directory as CLNP.PPE
  65.  
  66.   6. Edit the CLNP.* file(s) in a text editor for your board configuration and
  67.      color preferences.  (Instructions are contained in the CLNP.DAT file)
  68.  
  69.   7. Place the line: !DRIVE:\PATH\CLNP.PPE
  70.                  ie: !C:\PCB\PPE\CLNP.PPE
  71.  
  72.      somewhere in your login procedure, where it will be run during everyone's
  73.      login process.  It must be run each time a user logs in.  It simply checks
  74.      the .REP file to see if there are any note receipts, and checks the .NOT
  75.      file to see if there are any notes waiting for the user.  If there aren't,
  76.      it is pretty much transparent. (NOTE: *do not* manually edit the .NOT or
  77.      .REP files, they are binary files and editing will screw up the program)
  78.  
  79.      If you don't know how to make the PPE run during login, here is one way
  80.      to do it.  Put the line described above into your login NEWS file. Then
  81.      set the filedate on the NEWS file to one that is far into the future.
  82.      Run PCBSETUP, press G, press D and enter "Y" where it asks if you wish
  83.      to "Display the NEWS file only if changed".  By doing this, the news
  84.      file would be displayed during all logins, consequently forcing the PPE
  85.      to run.
  86.  
  87. ───────────────────────────────────────────────────────────────────────────────
  88.  
  89.  
  90. ───────────────────────────────────────────────────────────────────────────────
  91. [ EXTERNAL FILES ] ····························································
  92. ───────────────────────────────────────────────────────────────────────────────
  93.  
  94.   CLNP.DAT = Allows you to setup:
  95.  
  96.              1. The Display of the note box border.
  97.              2. Any text prompts the program uses.
  98.              3. Color's for the other items that are displayed.
  99.              4. Number of seconds to display the note before deletion. Since
  100.                 some users use scripts to call boards, the displaying of notes
  101.                 has a timeout feature.  After a configurable number of seconds,
  102.                 the PPE continues onto the next note, or continues with the
  103.                 login process.
  104.  
  105.   CLNP.DS1 = The file that is displayed in /EDIT mode to the user when they
  106.              load the PPE.  It is displayed right before the prompt that asks
  107.              the user to whom they wish to enter the note.  It basically
  108.              describes what the login note is, etc.
  109.  
  110.   CLNP.DS2 = The file that is displayed in /EDIT mode to the user after they
  111.              have decided to write a login note to a certain user.  It just
  112.              describes that they are being placed in a line editor, and have
  113.              two lines to write the note.
  114.  
  115.   CLNP.EX1 = The Exclusion List File #1.  If you put user names in this file
  116.              (1 to a line), those users will NOT be able to receive notes.
  117.              If certain users do not want to receive login notes from other
  118.              users, just place their name in this file and no one will be
  119.              allowed to write them any notes.
  120.  
  121.   CLNP.EX2 = The Exclusion List File #2.  If you put user names in this file
  122.              (1 to a line), they will not be able to access the note program
  123.              in /EDIT mode.  They can still receive notes from other users,
  124.              but are not able to send any notes to anyone.
  125.  
  126.              EX: CLNP.EX2
  127.              ------------
  128.              John Doe
  129.              Mary Jane
  130.              ------------
  131.  
  132.              Both John Doe and Mary Jane are NOT able to write login notes
  133.              to other users.
  134.  
  135. ───────────────────────────────────────────────────────────────────────────────
  136. [ HOW IT WORKS ] ······························································
  137. ───────────────────────────────────────────────────────────────────────────────
  138.  
  139.   CLNP.PPE - At Login.
  140.  
  141.              When this program is run (at login), it will scan the CLNP.REP
  142.              file first.  The CLNP.REP file is a binary file that contains
  143.              notices of receipt.  When User A sends a note to User B, and
  144.              then User B reads that note, a receipt is sent back to User A
  145.              so they know that User B has read their note.  This Receipt
  146.              simply states the date and time that User B read the note.
  147.  
  148.              Once the CLNP.REP file is checked, the PPE looks to see if any
  149.              notes are waiting for that user.  CLNP.NOT is a binary file
  150.              which contains all the notes.  If a note is found, it will
  151.              be displayed to the user.  The PPE will then either wait
  152.              for the number of seconds configured in the .DAT file before
  153.              continuing, or will continue when the user hits a key.
  154.  
  155.              If another note is awaiting the user, and the user has ANSI,
  156.              it will be displayed in the same note box.  If the user doesn't
  157.              have ANSI, a new note box will be drawn with the next note.
  158.  
  159.              As soon as the user reads the note, the note is deleted and
  160.              a receipt is sent in the CLNP.REP file to the originating user.
  161.  
  162.              Once all the notes have been read, the user continues on with
  163.              the normal login process.
  164.  
  165.   CLNP.PPE /EDIT - Edit Mode.
  166.  
  167.              When run in /EDIT mode, CLNP allows the user to write notes
  168.              to other users.  First, the CLNP.DS1 file is displayed. Then
  169.              a prompt is displayed (configurable in the .DAT file) to allow
  170.              the user to enter the user name (who they want to send the note
  171.              to - they must be a member of the BBS in the user file).  If
  172.              they want to send a note, and have input a valid user name, they
  173.              are placed in the editor.  The CLNP.DS2 file is displayed, and
  174.              they can then enter their two line note.  Any color codes
  175.              used are real-time displayed for the user so they can see what
  176.              their end note will look like during their editing.  Once
  177.              they have written their two lines, they can either 'S'end the
  178.              note, or 'A'bort it.  Once sent, it is added to the CLNP.NOT
  179.              file.
  180.  
  181. ───────────────────────────────────────────────────────────────────────────────
  182. [ RANDOM NOTES ] ······························································
  183. ───────────────────────────────────────────────────────────────────────────────
  184.  
  185.   If you install this PPE and play with it for a few minutes (send yourself
  186.   some notes), I'm sure everything will make more sense.  It can be helpful
  187.   to users who wish to notify another user of something important, or perhaps
  188.   the recipient doesn't read their EMail as much as they should and a login
  189.   note could notify them to do so, etc.  Think of it as a small, private
  190.   login auto-message that users can write to one another.
  191.  
  192.   Please *DO NOT* manually edit the .NOT or .REP file.  If you do, it will
  193.   corrupt the entire file, and you will have to delete both files if you
  194.   want the program to function properly.  They are not text files.
  195.  
  196. ───────────────────────────────────────────────────────────────────────────────
  197.       How to contact the author:  Yell real loud, perhaps I'll hear you.
  198.                              or:  mslasher@io.org
  199. ───────────────────────────────────────────────────────────────────────────────
  200. [EOF] ················································· [MS] / Midnight Slasher
  201. ───────────────────────────────────────────────────────────────────────────────
  202.